Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated installation guide with steps for windows #78

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Rohan-cod
Copy link
Contributor

Description

Updated the installation guide in README.md and QUIKSTART.rst with steps on how to install vcf2fhir on windows.

Fixes #70

How Has This Been Tested?

The code has been tested by running all the unit tests using the command python -m unittest and validated the PEP 8 formatting using pycodestyle.

  • Unit Tests
  • PEP 8 Formatting Validation

Updated the installation guide with steps on how to install vcf2fhir on windows.
Comment on lines +8 to +9
Install and add [Ubuntu WSL](https://www.microsoft.com/en-in/p/ubuntu-1804-lts/9n9tngvndl3q?rtc=1&activetab=pivot:overviewtab) to the [windows terminal](https://www.microsoft.com/en-in/p/windows-terminal/9n0dx20hk701?activetab=pivot:overviewtab). (Only for windows users!)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pre-requisite

Windows
  • vcf2fhir is supported only on Unix and Linux systems. To run it on windows install Ubuntu WSL.

vcf2hfir

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need: add to the windows terminal in the document? Are there special steps required to add it to the terminal? If yes, we should list that instead of just a statement.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also wanted to investigate why does user needs to install pip install cython wheel, but I never got enough time. Can you help look at this too?
I think we are missing something in our build process. cython and wheel should only be needed for running from the source. If people are downloading from pip they should get the compiled binary.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @srgothi92,

Do we need: add to the windows terminal in the document? Are there special steps required to add it to the terminal? If yes, we should list that instead of just a statement.

Should I add this link for the steps to add Ubuntu WSL to the windows terminal?

why does user needs to install pip install cython wheel

I checked this one, and I think it is a requirement for pyrle. When I tried installing vcf2fhir in a virtual environment without installing cython wheel I received the following error:

Screenshot 2021-06-13 at 9 58 30 PM

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I add this link for the steps to add Ubuntu WSL to the windows terminal?

Without these steps, you can't use WSL?

I checked this one, and I think it is a requirement for pyrle.

That's strange. What happens if you try to pip install pyranges do we get the same error? If not, then it's strange that we get this error. If we do get an errr, we should check with pyranges developer.

Copy link
Contributor Author

@Rohan-cod Rohan-cod Jun 14, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we open an issue on pyranges and see what the maintainer has to say.

I just looked at the open issues in pyranges and they seem to be working on this one(here). In that issue, there is a mention of this pull request in sorted_nearest. That pull request adds the build-time requirements for the package. Should we similarly add setuptools, Cython, and Wheel as build-time requirements for vcf2fhir or wait for pyranges to be updated?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That pull request adds the build-time requirements for the package. Should we similarly add setuptools, Cython, and Wheel as build-time requirements for vcf2fhir or wait for pyranges to be updated?

Sure, you can try that if it works and open an issue in our repository to fix it later when it is addressed upstream.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay I was finally able to find some time and install vcf2fhir on my windows machine using WSL. However, with this issue I was looking to install vcf2fhir natively on windows. I tried pysam and it install fine on windows with conda packaging. May be we should try conda package on windows instead of suggesting WSL path.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May be we should try conda package on windows instead of suggesting WSL path.

Sure, I will try installing vcf2fhir via conda once it gets deployed on the bioconda channel. :)

Copy link
Contributor

@srgothi92 srgothi92 Jun 29, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I will try installing vcf2fhir via conda once it gets deployed on the bioconda channel. :)

Before publishing to biconda channel we should first test with our personal channel similar to what we do with test pypi.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support vcf2fhir on windows !
2 participants